QueryFeatureHistory

The QueryFeatureHistory web serviceClosed XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to query a SubscriptionClosed A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription to retrieve the Features associated with a Subscription, and the history of changes that have been made on that Feature.

The userClosed A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMPClosed Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Subscription Number or NetworkClosed In the context of CMP, the infrastructure on which usage of registered customers will be measured – this could be a mobile phone network, broadband network or other non-telecommunications network. Serial Number and a Feature Code.

QueryFeatureHistory Request

The QueryFeatureHistory tag instructs the Features Service to query and return the details of a Subscription Feature. This request contains the following elements:

Element Name

Content Type

Description

Required?

ExternalReference

String69

The client may use this identifier to correlate the request and the response.

Optional

TargetIdentifier

Container - Choice

Choice of:

  • SubscriptionIdentifier, Integer8, the CMP Subscription Number, optional.
  • NetworkSerialNumber, String25, the Network Serial Number associated with the CMP Subscription, optional.

Mandatory

FeatureCode

String6

The code associated with the Feature to be queried, as configured in CMP.

Mandatory

Sample QueryFeatureHistory Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:def="http://mdsuk.com/ws/dise3g/features/definition">
<soapenv:Header/>
<soapenv:Body>
<def:QueryFeatureHistory>
<def:Request>
<!--You may enter the following 3 items in any order-->
<!--Optional:-->
<ExternalReference>?</ExternalReference>
<TargetIdentifier>
<!--You may enter the following 2 items in any order-->
<!--Optional:-->
<SubscriptionIdentifier>1855678</SubscriptionIdentifier>
<!--Optional:-->
<!-- <NetworkSerialNumber>?</NetworkSerialNumber> -->
</TargetIdentifier>
<FeatureCode>NF9999</FeatureCode>
</def:Request>
</def:QueryFeatureHistory>
</soapenv:Body>
</soapenv:Envelope>

QueryFeatureHistory Response

The QueryFeatureHistory response is the response to the QueryFeatureHistory Request. It contains the following elements:

Element Name

Content Type

Description

Required?

ExternalReference

String69

Returned unmodified in the response. The client may use this identifier to correlate the request and the response.

Optional

FeatureCode

String6

The unique CMP code configured for the Feature.

Mandatory

FeatureDescription

String

The CMP description configured for the Feature.

Mandatory

Histories

Container

See Histories Response Container for details.

Mandatory

Histories Response Container

The Histories response container contains the following elements:

Element Name

Content Type

Description

Required?

History

Container

See History Response Container for details.

Mandatory

History Response Container

The History response container has the following elements:

Element Name

Content Type

Description

Required?

FeatureAction

String

The specific action the Feature performs, for example enable, disable, bar, unbar).

Mandatory

FeatureStatus

String

The current status of the Feature, for example pending, success, failure.

Mandatory

EffectiveDate

Date

The Feature effective date. YYYY-MM-DDZ

Mandatory

ConfirmationDate

Date

The Feature confirmation date. YYYY-MM-DDZ

Mandatory

ActionWorkflow

String

The CMP Workflow Event Code linked to the Feature.

Mandatory

Sample QueryFeatureHistory Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns2:QueryFeatureHistoryResponse xmlns:ns2="http://mdsuk.com/ws/dise3g/features/definition" xmlns:ns3="http://mdsuk.com/ws/dise3g/fault/definition">
<ns2:Response>
<ExternalReference>?</ExternalReference>
<FeatureCode>NF9999</FeatureCode>
<FeatureDescription>desc</FeatureDescription>
<Histories>
<History>
<FeatureAction>BAR</FeatureAction>
<FeatureStatus>PENDING</FeatureStatus>
<EffectiveDate>2015-06-25T16:33:17Z</EffectiveDate>
<ConfirmationDate>1899-01-01T00:00:00Z</ConfirmationDate>
<ActionWorkflow>202799389</ActionWorkflow>
</History>
<History>
<FeatureAction>ENABLE</FeatureAction>
<FeatureStatus>PENDING</FeatureStatus>
<EffectiveDate>2015-06-27T15:28:27Z</EffectiveDate>
<ConfirmationDate>1899-01-01T00:00:00Z</ConfirmationDate>
<ActionWorkflow>202799415</ActionWorkflow>
</History>
<History>
<FeatureAction>ENABLE</FeatureAction>
<FeatureStatus>PENDING</FeatureStatus>
<EffectiveDate>2015-07-07T16:27:16Z</EffectiveDate>
<ConfirmationDate>1899-01-01T00:00:00Z</ConfirmationDate>
<ActionWorkflow>202799432</ActionWorkflow>
</History>
</Histories>
</ns2:Response>
</ns2:QueryFeatureHistoryResponse>
</soapenv:Body>
</soapenv:Envelope>